<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the encrypt method from the AES class, for the Dart programming language.">
  <title>encrypt method - AES class - aes library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../../static-assets/github.css?v1">
  <link rel="stylesheet" href="../../static-assets/styles.css?v1">
  <link rel="icon" href="../../static-assets/favicon.png?v1">

  
</head>


<body data-base-href="../../" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../../index.html">crypto_dart</a></li>
    <li><a href="../../aes/aes-library.html">aes.dart</a></li>
    <li><a href="../../aes/AES-class.html">AES</a></li>
    <li class="self-crumb">encrypt&lt;<wbr><span class="type-parameter">Text</span>, <span class="type-parameter">Key</span>&gt; method</li>
  </ol>
  <div class="self-name">encrypt</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        brightness_4
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        brightness_5
      </span>
    </label>
  </div>
</header>
<main>

  <div
      id="dartdoc-main-content"
      class="main-content"
      data-above-sidebar="aes&#47;AES-class-sidebar.html"
      data-below-sidebar="">
      <div>
<h1><span class="kind-method">encrypt&lt;<wbr><span class="type-parameter">Text</span>, <span class="type-parameter">Key</span>&gt;</span> method 
</h1></div>

    <section class="multi-line-signature">
      
  <div>
    <ol class="annotation-list">
        <li>@<a href="https://api.dart.dev/stable/3.3.0/dart-core/override-constant.html">override</a></li>
    </ol>
  </div>

<span class="returntype"><a href="../../crypto_dart/CipherParams-class.html">CipherParams</a></span>
<span class="name ">encrypt</span>&lt;<wbr><span class="type-parameter">Text</span>, <span class="type-parameter">Key</span>&gt;(<wbr><ol class="parameter-list"><li><span class="parameter" id="encrypt-param-plainText"><span class="type-annotation">Text?</span> <span class="parameter-name">plainText</span>, </span></li>
<li><span class="parameter" id="encrypt-param-key"><span class="type-annotation">Key?</span> <span class="parameter-name">key</span>, </span></li>
<li><span class="parameter" id="encrypt-param-options">{<span class="type-annotation"><a href="../../crypto_dart/CipherOptions-class.html">CipherOptions</a>?</span> <span class="parameter-name">options</span>}</span></li>
</ol>)

      <div class="features"><span class="feature">override</span></div>

    </section>
    
<section class="desc markdown">
  <p>The <code>encrypt</code> method takes in plain text, a key, and optionally an initialization vector (iv) and cipher options.
It returns a <code>CipherParams</code> object which contains the encrypted data.
The method is generic and can work with any type of data for the plain text, key, and iv.</p>
</section>


    
<section class="summary source-code" id="source">
  <h2><span>Implementation</span></h2>
  <pre class="language-dart"><code class="language-dart">@override
CipherParams encrypt&lt;Text, Key&gt;(Text? plainText, Key? key,
    {CipherOptions? options}) {
  assert(plainText != null &amp;&amp; key != null);
  areParamsVaild(plainText, key, options: options);

  final Uint8List encrypted;

  final Uint8List ctbytes = getPlaintText(plainText, enc.Utf8);

  final Uint8List _key;
  final Uint8List _iv;

  final mode = options?.mode ?? Mode.CBC;
  final paddingUsed = options?.padding ?? pad.Padding.PKCS7;
  final padding = getPadding(paddingUsed);
  final Uint8List? salt;
  if (key is String &amp;&amp; options?.keyEncoding == null) {
    salt = getSalt(options?.salt ?? generateSalt(_SALT_SIZE), _SALT_SIZE);
    final keyAndIV = CryptoDart.EvpKDF(
      password: enc.Utf8.parse(key),
      keySize: _KEY_SIZE,
      ivSize: _IV_SIZE,
      salt: salt,
      hasher: _KDF_DIGEST,
      iterations: 1,
    );

    _key = keyAndIV.key;
    _iv = keyAndIV.iv;

    final cipherText = _runAes(
        forEncryption: true,
        key: _key,
        iv: _iv,
        plaintext: ctbytes,
        mode: mode,
        padding: padding);

    var sbytes = enc.Utf8.parse(_APPEND);
    var b = Uint8List(_IV_SIZE + cipherText.length);

    arrayCopy(sbytes, 0, b, 0, sbytes.length);
    arrayCopy(salt, 0, b, _SALT_SIZE, _SALT_SIZE);
    arrayCopy(cipherText, 0, b, 16, cipherText.length);

    encrypted = b;
  } else {
    _key = getKey(key, options?.keyEncoding);

    _iv = getIV(options?.iv, _IV_SIZE, options?.ivEncoding);
    salt = null;
    encrypted = _runAes(
        forEncryption: true,
        iv: _iv,
        key: _key,
        mode: mode,
        padding: padding,
        plaintext: ctbytes);
  }

  return CipherParams(
    cipherText: encrypted,
    iv: _iv,
    key: _key,
    mode: mode,
    padding: paddingUsed,
    salt: salt,
  );
}</code></pre>
</section>


  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="../../index.html">crypto_dart</a></li>
    <li><a href="../../aes/aes-library.html">aes</a></li>
    <li><a href="../../aes/AES-class.html">AES</a></li>
    <li class="self-crumb">encrypt&lt;<wbr><span class="type-parameter">Text</span>, <span class="type-parameter">Key</span>&gt; method</li>
</ol>


    <h5>AES class</h5>
    <div id="dartdoc-sidebar-left-content"></div>
  </div><!--/.sidebar-offcanvas-->

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    crypto_dart
      1.0.3+2
  </span>

  
</footer>



<script src="../../static-assets/highlight.pack.js?v1"></script>
<script src="../../static-assets/docs.dart.js"></script>



</body>

</html>

